Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Update PULL_REQUEST_TEMPLATE.md #676

Merged
merged 1 commit into from
Jul 12, 2022
Merged

Conversation

Garandor
Copy link
Contributor

@Garandor Garandor commented Jul 12, 2022

Reduce checklist to mandatory only items

Signed-off-by: Adam Reif garandor@manta.network

relates to #600

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to Github issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Wrote unit tests.
  • Updated relevant documentation in the code.
  • Added one line describing your change in <branch>/CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer.
  • If runtime changes, need to update the version numbers properly:
    • authoring_version: The version of the authorship interface. An authoring node will not attempt to author blocks unless this is equal to its native runtime.
    • spec_version: The version of the runtime specification. A full node will not attempt to use its native runtime in substitute for the on-chain Wasm runtime unless all of spec_name, spec_version, and authoring_version are the same between Wasm and native.
    • impl_version: The version of the implementation of the specification. Nodes are free to ignore this; it serves only as an indication that the code is different; as long as the other two versions are the same then while the actual code may be different, it is nonetheless required to do the same thing. Non-consensus-breaking optimizations are about the only changes that could be made which would result in only the impl_version changing.
    • transaction_version: The version of the extrinsics interface. This number must be updated in the following circumstances: extrinsic parameters (number, order, or types) have been changed; extrinsics or pallets have been removed; or the pallet order in the construct_runtime! macro or extrinsic order in a pallet has been changed. You can run the metadata_diff.yml workflow for help. If this number is updated, then the spec_version must also be updated
  • Verify benchmarks & weights have been updated for any modified runtime logics
  • If importing a new pallet, choose a proper module index for it, and allow it in BaseFilter. Ensure every extrinsic works from front-end. If there's corresponding tool, ensure both work for each other.
  • If needed, update our Javascript/Typescript APIs. These APIs are officially used by exchanges or community developers.
  • If modifying existing runtime storage items, make sure to implement storage migrations for the runtime and test them with try-runtime. This includes migrations inherited from upstream changes, and you can search the diffs for modifications of #[pallet::storage] items to check for any.

Reduce checklist to mandatory only items

Signed-off-by: Adam Reif <garandor@manta.network>
@Garandor Garandor changed the title Update PULL_REQUEST_TEMPLATE.md Minor: Update PULL_REQUEST_TEMPLATE.md Jul 12, 2022
@ghzlatarev ghzlatarev linked an issue Jul 12, 2022 that may be closed by this pull request
@ghzlatarev ghzlatarev merged commit df5883d into manta Jul 12, 2022
@ghzlatarev ghzlatarev deleted the Garandor-patch-1-1 branch July 12, 2022 19:27
@Garandor
Copy link
Contributor Author

@ghzlatarev why tf were you able to merge this with a failed CI?

@Garandor Garandor added this to the v3.2.1 milestone Jul 12, 2022
@ghzlatarev
Copy link
Contributor

ghzlatarev commented Jul 14, 2022

@ghzlatarev why tf were you able to merge this with a failed CI?

I probably just ignored the failure, because the change is only in the template file.
But the reason why it was possible is because Brandon hasn't set it in the the branch protection rules yet, contrary to what I thought until recently. We discussed this a few days ago in the internal chat.

@Apokalip Apokalip added the L-changed Log: Issues and PRs related to changes label Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L-changed Log: Issues and PRs related to changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tracking: Improve documentation
4 participants